Create Glossary.md #15278
Create Glossary.md #15278
Conversation
Glossary of Terms added to TT-Metalium repo
bbeggsTT
requested review from
abhullar-tt,
pgkeller,
aliuTT,
tt-aho,
tt-dma,
tt-asaigal and
ubcheema
as code owners
|
I have often heard T3000 / T3K used interchangeably with Loud Box ... not sure if it is relevant to what you want to document. Also ... I've heard the terms NCRISC and BRISC ... not sure if needed to be defined publicly NoC Control RISC They are two of the cores in the Tensix Core block. |
|
Can we name the file something without spaces? i.e. |
|
I found T3000 referenced on this page: Also ERISC |
bbeggsTT
requested review from
blozano-tt
and removed request for
davorchap and
blozano-tt
There was a problem hiding this comment.
I was going through the PRs and seeing what feature are in development that I will be able to use shortly. Usually I go out of my way to not interfere with what TT does internally. But this document feels very not focused and confusing. I want to raise a flag as I feel newly joining FOSS developers would be more confused after reading the new document in the PR. And I want to avoid me explaining constantly on discord in the future.
I've highlighted some errors I saw at a glance. There's much more but the list is long enough.
Apologies if TT find this comment inappropriate or anything. Like said, I try to not interfere but this feels like an exception (we are on GitHub after all). LMK if I should delete it. Sorry for the trouble.
Best,
Martin
| - **Topology -** Physical organization of a device. | ||
| - **Linear Topology -** All devices or components are connected to a common source. | ||
| - **Mesh Topology -** Network configuration where all devices or components are connected to each other. | ||
| - **Torus Topology -** Interconnect switchless network configuration connecting processors used often for parallel systems. |
There was a problem hiding this comment.
That's not how different topologies work. Also you can't organize one device. What you are describing is a star, fully connected and layered topo,
There was a problem hiding this comment.
Why is this close? It's still wrong and not updated
Why do you say it’s not focused? I believe the primary purpose here is to disambiguate acronyms used in other documents. PS, your input is always welcomed |
|
@blozano-tt A glossary would be one of the palces where new developers reads first, after readme and install. To understand what tech is used and what to expect - think it like a fire hose style introduction to the repository. The PR contains information not relevant to TT or the Metal repo. For instance
These are not used anywhere in the repo. Metalium does not contain any Java code nor anything that compiles down to JVM. As a newcomer I'll be looking out for Java code, which does not exist. Also:
If I were a newcomer, upon reading this part of the glossary, I would expect TT hardware to support FP64, FP32 and FP16. Which is not the case, Wormhole only supports FP32 and BFP16 (FP16 not enabled in Metalium). For TT, it would also be great to mention BFLOAT8/4/2_B formats as that's the actual mixed precision TT supports. Also another critical error. Which will lead to me needing to correct newcomers on discord. Besides, it's bad look of TT having documentation errors on TT's own hardware. SFPU is the vector unit.
IMO, a reasonable mental model is like, assuming you are a new developer reading the doc. How much false impression you'll get. |
|
@marty1885 many good points. Thanks very much, we will clean this up. |
| @@ -0,0 +1,145 @@ | |||
| # Glossary of Terms | |||
| ## **Tenstorrent Devices:** ## | |||
There was a problem hiding this comment.
Should put the different names for harvested chips as well
| - **TT-MLIR -** Tenstorrent’s MLIR-based compiler. | ||
| - **TT-NN -** Tenstorrent’s library of optimized operators. | ||
| - **Watcher -** Tenstorrent monitoring tool. | ||
| ## **Acronyms:** ## |
There was a problem hiding this comment.
I would group them into meaningful sections. Right now, this list seems really random.
| - **Cmake -** Cross-platform free and open-source software for build automation, testing, packaging and installation of software by using a compiler-independent method. | ||
| - **Deterministic Programming -** Programming style where the same input will always produce the same output. | ||
| - **dim -** Dimension. | ||
| - **DPRINT -** Configurable code formatting platform. |
There was a problem hiding this comment.
this is our kernel print command
There was a problem hiding this comment.
Why is this comment marked as resolved?
No need to apologize @marty1885 , we really appreciate the feedback and this is why we are open source, to have everyone have the opportunity to contribute and provide feedback. When I worked in past companies open-source projects sometimes were a proprietary repo ported to GitHub once a quarter or something, but here all our development and in progress PRs are all transparent allowing people to contribute even before things are in. |
Updated this document according to reviewer feedback.
|
Thanks for the feedback everyone. I created this glossary as a reference document for other documents in the future that can use a link to a glossary rather than having to redefine commonly used terminology throughout the TT-Metal Repo. To start I was just adding any terminology/acronym I was unfamiliar with while going through existing documentation. It is very helpful to have people letting me know where I am inaccurate or what should be omitted completely. If anyone sees any definitions that I am missing and should include here please let me know. Again, all feedback is welcome! Thanks! |
Updates based on reviews.
minor edits
Glossary.md added to TT-Metalium repo
Ticket
#13842
Problem description
Glossary.md added to TT-Metalium repo
What's changed
New document added.
Checklist